Skip to content

Swagger changes#47

Merged
helenKaryamsetty merged 1 commit into
PSMRI:developfrom
ravishanigarapu:develop
Apr 17, 2025
Merged

Swagger changes#47
helenKaryamsetty merged 1 commit into
PSMRI:developfrom
ravishanigarapu:develop

Conversation

@ravishanigarapu
Copy link
Copy Markdown
Contributor

@ravishanigarapu ravishanigarapu commented Apr 17, 2025 •
edited by coderabbitai Bot
Loading

📋 Description

JIRA ID: AMM-1186

Please provide a summary of the change and the motivation behind it. Include relevant context and details.

✅ Type of Change

  • 🐞 Bug fix (non-breaking change which resolves an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 🔥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 🛠 Refactor (change that is neither a fix nor a new feature)
  • ⚙️ Config change (configuration file or build script updates)
  • 📚 Documentation (updates to docs or readme)
  • 🧪 Tests (adding new or updating existing tests)
  • 🎨 UI/UX (changes that affect the user interface)
  • 🚀 Performance (improves performance)
  • 🧹 Chore (miscellaneous changes that don't modify src or test files)

ℹ️ Additional Information

Please describe how the changes were tested, and include any relevant screenshots, logs, or other information that provides additional context.

Summary by CodeRabbit

  • New Features

    • Added configuration options to enable or disable API documentation and Swagger UI based on environment settings.

  • Bug Fixes

    • Improved request handling to bypass authentication for API documentation and token refresh endpoints.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 17, 2025 •
edited
Loading

Walkthrough

Two new properties were introduced to the CI configuration to control the enabling of Springdoc OpenAPI and Swagger UI based on an environment variable. Additionally, the JWT user ID validation filter was updated to exclude API documentation and token refresh endpoints from its processing, extending the list of paths that bypass JWT validation.

Changes

File(s) Change Summary
src/main/environment/common_ci.properties Added springdoc.api-docs.enabled and springdoc.swagger-ui.enabled properties, both set from SWAGGER_DOC_ENABLED.
src/main/java/com/iemr/tm/utils/JwtUserIdValidationFilter.java Extended exclusion logic to skip JWT validation for /swagger-ui, /v3/api-docs, and /user/refreshToken paths.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant JwtUserIdValidationFilter
    participant API

    Client->>JwtUserIdValidationFilter: HTTP Request (any path)
    alt Path is /login, /logout, /public, /swagger-ui, /v3/api-docs, /user/refreshToken
        JwtUserIdValidationFilter->>API: Pass through without JWT validation
    else
        JwtUserIdValidationFilter->>API: Validate JWT, then forward request
    end
    API->>Client: Response
Loading
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 71c307a and 1455390.

📒 Files selected for processing (2)
  • src/main/environment/common_ci.properties (1 hunks)
  • src/main/java/com/iemr/tm/utils/JwtUserIdValidationFilter.java (1 hunks)
🔇 Additional comments (2)
src/main/environment/common_ci.properties (1)

24-25: Configuration addition looks good for Swagger documentation.

The added properties correctly enable/disable Springdoc OpenAPI and Swagger UI based on the environment variable SWAGGER_DOC_ENABLED. This configuration provides the flexibility to control API documentation visibility across different environments.

src/main/java/com/iemr/tm/utils/JwtUserIdValidationFilter.java (1)

58-60: JWT filter exclusions properly updated for Swagger and token refresh.

The filter now correctly excludes Swagger UI paths (/swagger-ui), OpenAPI documentation endpoints (/v3/api-docs), and the token refresh endpoint (/user/refreshToken) from JWT validation, allowing these endpoints to be accessed without authentication.

This update aligns well with the Swagger configuration properties added in the properties file.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Apr 17, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@helenKaryamsetty helenKaryamsetty merged commit feb504f into PSMRI:develop Apr 17, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@helenKaryamsetty helenKaryamsetty helenKaryamsetty approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ravishanigarapu @helenKaryamsetty